/*
 *  Copyright 2010 SPECS Research Group.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *  under the License.
 */

package org.specs.Scripter;

import java.util.List;
import org.ancora.SharedLibrary.OptionsTable.OptionsTable;

/**
 *
 * @author Joao Bispo
 */
public interface Program {

   /**
    * Executes the given arguments. If the program creates threads,
    * it should only return after the threads that affect the state have
    * returned.
    *
    * @param arguments
    * @return
    */
   boolean execute(List<String> arguments, OptionsTable state);

   /**
    * @return a string with instructions for using the program
    */
   String getHelpMessage(OptionsTable state);
}
